home *** CD-ROM | disk | FTP | other *** search
/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / comm / term / tdb1_0.lha / TDB.Doc < prev    next >
Text File  |  1993-08-01  |  13KB  |  328 lines
  1. ***************************************************************************
  2. *                                                                         *
  3. *                  TDB v1.00 - Terminus DataBase utility                  *
  4. *                                                                         *
  5. *                       Written by Robert Nottage                         *
  6. *                                                                         *
  7. *                           Saturday 31/07/1993                           *
  8. *                                                                         *
  9. *     Distribution and copyright statements inspired by Bob Rye  :-)      *
  10. *                                                                         *
  11. ***************************************************************************
  12.  
  13. Everything contained in this release of TDB v1.00 for the Amiga is
  14. USE-AT-OWN-RISK. I, the author, make no guarantee as to the fitness for
  15. use of this software. I accept no responsibility for possible damages
  16. incurred before, during or after execution of this software.
  17.  
  18.  
  19.  ***  *    ****  **   *** ****   ***  ****  **  ***    ***** *  * *  ***   *
  20.  *  * *    *    *  * *    *      *  * *    *  * *  *     *   *  * * *      *
  21.  ***  *    ***  **** **** ***    ***  ***  **** *  *     *   **** * ****   *
  22.  *    *    *    *  *    * *      * *  *    *  * *  *     *   *  * *    *
  23.  *    **** **** *  * ***  ****   *  * **** *  * ***      *   *  * * ***    *
  24.  
  25. *****************************************************************************
  26.  
  27.                    DID YOU PAY MONEY FOR THIS SOFTWARE?
  28.  
  29.                                 TDB is FREE
  30.  
  31.  This software is FREE. This software is  "F R E E". If you have paid
  32.  money for this software, then you have been ripped off. I have written
  33.  this program for you, for free. If you paid for "support" from where you
  34.  got this file, then you are also being ripped off. There is only one
  35.  person who can fully help you with the operation of this program:
  36.  me! (Rob Nottage, the guy who wrote this program.)
  37.  
  38.  You cannot obtain support from some unqualified desk-doofus hiding behind
  39.  the facade of "a support specialist". All that these people are doing is
  40.  making money from you, the innocent end-user, and ripping me off by
  41.  immorally making money from *MY* programs.
  42.  
  43.  Please take a stand against these companies. Please don't buy *FREE*
  44.  software from these companies. If you would like copies of any (or all)
  45.  of the FREE software written by me, you can have them for *FREE*. That's
  46.  right, for nothing. All I ask for is a blank disk(s), to copy the programs
  47.  onto, and the cost of return postage (and your address!) or you can usually
  48.  filerequest them from me at the FidoNet and AmigaNet addresses below. Then
  49.  if you want "support" for my programs, send Netmail to me or snail-mail me
  50.  and you'll get real support.
  51.  
  52.                           STAND UP AND BE COUNTED.
  53.  
  54.                       Say NO! to costly FREE software.
  55.  
  56. *****************************************************************************
  57.  
  58. If you represent a PD/Shareware/Freeware library or electronic distribution
  59. system, then please feel free to contact me to gain written permission to
  60. allow you to legally include this software in your library, for
  61. distribution. The "ADS" electronic distribution system has my written
  62. permission to redistribute this software, as does Fred Fish.
  63.  
  64. You may copy and transfer copies of this package to whoever you like,
  65. provided that this package is transferred completely intact, with all
  66. documentation and executables unmodified therein (modification of
  67. copyrighted works is called "contributory copyright infringement" and
  68. persons found infringing copyright are liable to legal action); however,
  69. if you represent a registered (or otherwise) company, and you wish to
  70. redistribute this package, you MUST obtain my written permission. The
  71. copyright to TDB, the documentation, the source-code, and the actual
  72. software remains the explicit property of Robert Nottage, (C) 1993.
  73.  
  74. Distributors of this package must cease distributing this package, if
  75. and/or when, specifically requested to do so by the author(s). This request
  76. will be made in writing.
  77.  
  78. ANY commercial distribution of this package without the prior written
  79. consent of the author is expressly prohibited.
  80.  
  81.  
  82.  
  83.                                 DISCLAIMER
  84.                                 ¯¯¯¯¯¯¯¯¯¯
  85. ALTHOUGH OUTSTANDING BUGS IN THE CODE HAVE BEEN ELIMINATED, THERE REMAINS
  86. THE POSSIBILITY OF UNFORESEEN PROBLEMS. I RESERVE THE RIGHT TO REFUTE THE
  87. EXISTENCE OF SUCH 'BUGS', BUT IF FOUND, I WILL ATTEMPT TO FIX SUCH
  88. PROBLEM(S). IF, HOWEVER, UNFORESEEN BUGS ARE FOUND TO CAUSE YOU MENTAL
  89. AND/OR PHYSICAL ANGUISH, THEN THAT IS AS THEY SAY IN THE CLASSICS, BAD
  90. LUCK! I ACCEPT NO BLAME FOR ANY LOSS OR INCONVENIENCE FOUND TO ARISE FROM
  91. THE (MIS)USAGE OF THIS PROGRAM. I RESERVE THE RIGHT TO WITHDRAW SUPPORT
  92. AND UPGRADES AT ANY TIME. I PROBABLY WON'T DO THIS, BUT I HAVE THIS
  93. RIGHT.
  94.  
  95.  
  96. ALL INSTANCES OF COMPANY AND/OR PRODUCT NAMES ARE (C), (R) AND (TM)
  97. RESPECTIVELY, WHERE APPLICABLE. "TDB" AND "TDB.DOC" ARE COPYRIGHT
  98. ROBERT NOTTAGE 1993.
  99.  
  100. Minimum requirements
  101. --------------------
  102.  
  103. TDB has been extensively tested on:
  104.   Amiga 2000/000 (vanilla PAL, 2.04 OS)
  105.   Amiga 3000/030 (vanilla PAL, 2.04 OS)
  106.   Amiga 4000/040 (vanilla PAL, 3.0 OS?)
  107.  
  108. TDB will not work with OS version less than 2.xx nor with ReqTools less than
  109. v37.
  110.  
  111. What is it?
  112. -----------
  113.  
  114. TDB is database program to make it easy looking up Terminus functions and
  115. variables. The minimum requirements are:
  116.  
  117.  - An Amiga with Kickstart 2.x or greater
  118.  - gadtools.library (who doesn't have both of those together???  :-)
  119.  - ReqTools.library v37 or greater
  120.  - The supplied database file. TDB might not work with a modified database.
  121.  
  122. How do I use it?
  123. ----------------
  124.  
  125. TDB will run from CLI or Workbench.
  126.  
  127. The CLI commandline options and the Workbench tool-types are basically
  128. the same with the normal differences as noted. Tool-type keywords MUST
  129. be in uppercase.
  130.  
  131.   Options:
  132.  
  133. If you type from the CLI  'TDB ?' you will see a template of arguments
  134. like this:
  135.  
  136. FILE,PUBSCREEN,FONTNAME,FONTHEIGHT/N,ICONIFY/S,WINLEFT/N,WINTOP/N,ICONLEFT/N,
  137. ICONTOP/N,MAXHEIGHT/S,SORT/S:
  138.  
  139.  
  140. FILE:
  141.  
  142.   This allows you to specify the name of the database file. This may be
  143.   as simple as 'database' if the file is in the current directory, or
  144.   a full pathname. e.g:
  145.  
  146.   TDB FILE database
  147.   
  148.   or:
  149.   
  150.   TDB FILE MAIL:extra/tdbdatabase
  151.  
  152.   The FILE keyword may be omitted if you specify a filename as the
  153.   first option. e.g.
  154.  
  155.   TDB s:terminusdatabase
  156.  
  157.   The WB tool-type would look like this:
  158.  
  159.   FILE=database
  160.  
  161. PUBSCREEN:
  162.  
  163.   You can open the TDB window on any public screen. The iconified window
  164.   and any requesters will also appear on the same screen. Ensure that
  165.   you enter the correct case for the public screen name. e.g.
  166.  
  167.   TDB FILE database PUBSCREEN DOPUS.1    (not 'dopus.1')
  168.  
  169.   The WB tool-type would look like this:
  170.  
  171.   PUBSCREEN=TrapDoor
  172.  
  173. FONTNAME:
  174.  
  175.   You may, to some degree, use any FIXEDWIDTH font of your choice. The
  176.   font must be taller than 5 points and the window must be able to
  177.   open to a predetermined number of characters wide and high. If you
  178.   omit FONTNAME or the font cannot be used, then TDB will consider opening
  179.   the window using the default screenfont. If this is also not usable
  180.   then topaz 8 will be the font used. The '.font' extension is optional. e.g.
  181.  
  182.   TDB FILE database FONTNAME cleanibm
  183.  
  184.   The WB tool-type would look like this:
  185.  
  186.   FONTNAME=jrcibm.font
  187.  
  188. FONTHEIGHT:
  189.  
  190.   The font height must be greater than 5 points. If you omit this option
  191.   when using FONTNAME then the default will be 8 points. e.g.
  192.  
  193.   TDB FILE s:database FONTNAME cleanibm FONTHEIGHT 9
  194.  
  195.   The WB tool-type would look like this:
  196.  
  197.   FONTHEIGHT=11
  198.  
  199. ICONIFY:
  200.  
  201.   This switch allows you to open directly into the iconified mode. e.g.
  202.  
  203.   TDB FILE database ICONIFY
  204.  
  205.   The WB tool-type would look like this:
  206.  
  207.   ICONIFY
  208.  
  209. WINLEFT,WINTOP,ICONLEFT,ICONTOP:
  210.  
  211.   These options allow you to specify the initial position of the TDB
  212.   window or iconified window on the screen. WINLEFT and WINTOP specify
  213.   the TDB window left and top position. ICONLEFT and ICONTOP specify
  214.   the iconified window left and top position. Each defaults to 0. e.g.
  215.  
  216.   TDB FILE database WINTOP 11 ICONLEFT 500 ICONTOP 0
  217.  
  218.   The WB tool-types would look like this:
  219.  
  220.   WINLEFT=20
  221.   WINTOP=12
  222.   ICONLEFT=550
  223.   ICONTOP=1
  224.  
  225. MAXHEIGHT:
  226.  
  227.   Normally TDB will give you a textviewing area of 6 lines. You can force
  228.   TDB to open a window to fit the maximum number of lines with this option.
  229.  
  230. SORT:
  231.  
  232.   The Terminus functions and variables are listed separately in the database.
  233.   You can have these mixed together and globally sorted with this option.
  234.  
  235. The GUI
  236. -------
  237.  
  238. Once you have got TDB up and running, you should be viewing the first
  239. Terminus function/variable. Please consult the Terminus manual for the
  240. meanings of SCOPE, <aexpr> etc. Some functions and variables do not
  241. have defaults.
  242.  
  243. Use the LISTVIEW gadget in the upper left corner to move about the list
  244. of functions and variables. Click on the required choice and you can
  245. now view the information. The large text area at the bottom gives you
  246. the syntax for the function in BOLD and an explanation of the usage below
  247. that. Use the scroll gadget to the right to view more text.
  248.  
  249. Each Terminus function and variable can be used in different Terminus
  250. script and config files. The five boxes near the middle of the window
  251. will show a checkmark if you can use the currently viewed function in that
  252. type of script/config file.
  253.  
  254. You may search for virtually any string of characters by selecting the SEARCH
  255. button. Just enter the string to search for in the requester that pops up.
  256. The string will be search for in ALL fields including 'scope' and 'default'.
  257. You can even enter '.con' as a search string and find any function or
  258. variable that is permitted in a '.con' console definition file.
  259. Search is CASE INSENSITIVE.
  260.  
  261. Once you have found a match, you can then select the RESUME button and the
  262. next occurence will be found, if any.
  263.  
  264. You can browse from one function to the next with the BROWSE button. This
  265. will start at the beginning once you reach the end.
  266.  
  267. Help is also available. Use the menu item or press the HELP key.
  268.  
  269. There are several hotkeys available. All menus have an associated hotkey
  270. indicated in the menu. Press the LEFT AMIGA key along with the indicated
  271. key.
  272.  
  273. The UP and DOWN cursor keys are also available for use. Without pressing any
  274. qualifier keys, the cursor keys allow you to scroll the information text
  275. up and down. If you press SHIFT along with the cursor keys, you can jump
  276. from the top of the information text to the bottom and back.
  277. The cursor keys can also control the LISTVIEW gadget. If you press ALT
  278. with the cursor keys, you can scroll up and down the list. The information
  279. text will be updated as you go. Pressing CONTROL with the cursor keys allows
  280. you to jump to the top or bottom of the list.
  281.  
  282. To save your current settings, select the 'PROJECT' menu, Save prefs...
  283. item. All settings will be saved in 'ENV:TDB.Prefs'.
  284. The next time you use TDB, these settings will be used, but will be
  285. overridden by any commandline arguments you use. If you run TDB from
  286. the workbench, the saved settings will be IGNORED. Use the tool-types
  287. instead.
  288.  
  289. CREDITS & ACKNOWLEDGMENTS
  290. -------------------------
  291.  
  292. Terminus (C) John P. Radigan, the guy who knows how to get the best from
  293.                   your modem.
  294.  
  295. ReqTools (C) Nico François, the man with the loaded requester.
  296.  
  297. TDB is written in Amiga E (Amiga E by Wouter van Oortmerssen)
  298.                   (If you haven't tried Amiga E, you don't know what you're
  299.                   missing! It's even stealing some 'C' programmers  :-)
  300.  
  301. Thanx to Simon Richards for beta testing v1.00 and some of my other programs
  302.                   as well as finding any 68000 problems.
  303.  
  304. Thanx to Dwayne Lindner for beta testing v1.00 and most of my other programs
  305.                   as well as finding any WB3 & 68040 problems, and mailing
  306.                   Jack R.
  307.  
  308. Thanx to Jack Radigan for allowing me to include the database which is
  309.                   converted from the docs supplied with Terminus 2.0 & 2.0a
  310.  
  311. Contacting me
  312. -------------
  313.  
  314. Rob Nottage
  315. Please don't use 'Robert', nothing recognizes that name, other than the
  316. copyright ownership and distribution restrictions (least of all me  :-)
  317.  
  318. Mail: 10 Chilver Street, Kewdale, Western Australia, 6105
  319. Fax : +61 9 458-0154
  320. Fido: 3:690/662.0   AmigaNet: 41:616/662.0 *Mail Only*
  321. BBS : +61 9 370-3333 @ 2400 370-3170 @ v.32/v.32bis/v.42bis (Only a user here)
  322.  
  323. History
  324. -------
  325.  
  326. v1.00    31-Jul-93
  327.          (Added changes to DISPLAY and removed DISPID for v2.0a of Terminus)
  328.